purgecss

What is purgecss?

PurgeCSS is a tool to remove unused CSS. It can be used as part of your development workflow to reduce the size of your CSS files by removing unused selectors.

What are purgecss's main functionalities?

Basic Usage

This code demonstrates the basic usage of PurgeCSS. It scans HTML files and CSS files to remove unused CSS selectors.

const PurgeCSS = require('purgecss');
const purgeCSSResults = new PurgeCSS().purge({
  content: ['**/*.html'],
  css: ['**/*.css']
});
console.log(purgeCSSResults);

Using with PostCSS

This code shows how to integrate PurgeCSS with PostCSS. It processes CSS files and removes unused selectors based on the content of HTML files.

const postcss = require('postcss');
const purgecss = require('@fullhuman/postcss-purgecss');

postcss([
  purgecss({
    content: ['./src/**/*.html']
  })
]).process(css, { from: 'src/app.css', to: 'dist/app.css' })
  .then(result => {
    console.log(result.css);
  });

Using with Webpack

This code demonstrates how to use PurgeCSS as a Webpack plugin. It scans the specified paths for content and removes unused CSS selectors during the Webpack build process.

const PurgeCSSPlugin = require('purgecss-webpack-plugin');
const glob = require('glob');
const path = require('path');

module.exports = {
  // other webpack config
  plugins: [
    new PurgeCSSPlugin({
      paths: glob.sync(`${path.join(__dirname, 'src')}/**/*`, { nodir: true }),
    }),
  ],
};

Other packages similar to purgecss

uncss

UnCSS is a tool that removes unused CSS from your stylesheets. It works similarly to PurgeCSS by scanning your HTML files to determine which CSS selectors are not used. However, UnCSS is generally considered to be less flexible and slower compared to PurgeCSS.

purify-css

PurifyCSS is another tool for removing unused CSS. It scans your HTML and JavaScript files to find which CSS selectors are used. While it is similar to PurgeCSS, it is not as actively maintained and may lack some of the advanced features and integrations that PurgeCSS offers.

csso

CSSO (CSS Optimizer) is a CSS minifier that also has the capability to remove unused CSS. It is primarily focused on minification and optimization, but it can also be used to remove unused CSS selectors. CSSO is generally faster but may not be as thorough in removing unused CSS as PurgeCSS.

README

PurgeCSS

What is PurgeCSS?

When you are building a website, chances are that you are using a css framework like Bootstrap, Materializecss, Foundation, etc... But you will only use a small set of the framework and a lot of unused css styles will be included.

This is where PurgeCSS comes into play. PurgeCSS analyzes your content and your css files. Then it matches the selectors used in your files with the one in your content files. It removes unused selectors from your css, resulting in smaller css files.

Version 1

If you are looking for PurgeCSS 1, the documentation is here

Documentation

You can find the PurgeCSS documentation on this website.

Table of Contents

PurgeCSS

• Configuration
• Command Line Interface
• Programmatic API
• Whitelisting
• Extractors
• Comparison

Plugins

• PostCSS
• Webpack
• Gulp
• Grunt
• Gatsby

Guides

• Vue.js
• Nuxt.js
• React.js
• Next.js
• Razzle

Getting Started

Installation

npm i --save-dev purgecss

Usage

import PurgeCSS from 'purgecss'
const purgeCSSResults = await new Purgecss().purge({
  content: ['**/*.html'],
  css: ['**/*.css']
})

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

PurgeCSS use SemVer for versioning.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Changelog

3.0 (2020-09-06)

Features

• CLI: add blocklist option (3961afb)
• add blocklist option (04223f7)
• add safelist option, replace whitelist
• add safelist keyframes and css variables (dc59d30), closes #418 #439